Task-oriented documentation #64
Conversation
This reverts commit c48e210.
doc/rexml/tasks/mktocs.rb
Outdated
| @@ -0,0 +1,72 @@ | |||
| Dir.chdir(File.dirname(__FILE__)) do | |||
There was a problem hiding this comment.
Could you define this as a rdoc:toc:generate Rake task in Rakefile?
There was a problem hiding this comment.
Could you define this as a
rdoc:toc:generateRake task inRakefile?
Sorry, I meant to say more (and better). My initial question is Do we want this sort of thing?
If yes, everything else can come later: correctness, robustness of TOC build, etc.
Also, Element is not completed, so there are some hanging issues there.
There was a problem hiding this comment.
It's acceptable.
It's better that RDoc provides the TOC feature as a build-in feature. For example, [:toc:] is expanded to TOC on rendering phase. But it seems that RDoc doesn't provide the TOC feature. (Could you request the feature to RDoc?)
So it's reasonable that we have TOC generator for us for now.
There was a problem hiding this comment.
It's acceptable.
This is a lot of work, so needs to be much more than 'acceptable.' Do you like the 'task' concept?
There was a problem hiding this comment.
Rakefile updated with task tocs:generate.
There was a problem hiding this comment.
It's acceptable.
It's better that RDoc provides the TOC feature as a build-in feature. For example,
[:toc:]is expanded to TOC on rendering phase. But it seems that RDoc doesn't provide the TOC feature. (Could you request the feature to RDoc?)So it's reasonable that we have TOC generator for us for now.
@kou, I have created the feature request: ruby/rdoc#801
|
Can we merge this pull request? |
Fine with me to merge. I'll continue in a new PR. |
|
OK. I've merged. |
The important page is the master table of contents in ..\doc\rexml\tasks\tocs\master_toc.rdoc
The idea is to let the user find the relevant task, then follow a link to see code that does that.
I started out calling these recipes, but so far each is little, so I think task is a better term.
The best way to view these is to run RDoc and begin at the master toc html page.